/*
 * Copyright 2016 Red Hat, Inc. and/or its affiliates.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *       http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

package org.uberfire.ext.widgets.common.client.dropdown;

/**
 * Interface used to feed the {@link PerspectiveDropDown} widget with user friendly perspective names.
 */
public interface PerspectiveNameProvider {

    /**
     * Get a user friendly name for the given perspective identifier
     * @param perspectiveId The id. of an existing perspective.
     * @return A displayable name
     */
    String getPerspectiveName(String perspectiveId);
}